package com.nw.dsl4j.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * a basic rule. 
 * 
 * @author elik
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Rule {
	/**
	 * the pattern of this rule. see reference manual for more 
	 * information on how to construct patterns
	 * @return
	 */
	public String pattern() default "";
	/**
	 * This pattern is used to hint the parser when it determines that
	 * more than one alternative is possible based on the pattern given. 
	 * @return
	 */
	public String hint() default "";
}
